////////////////////////////////////////////////////////////////////////////////////////////////////
/// Copyright (c) 2009 - 2010 RacoonStudios
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this
/// software and associated documentation files (the "Software"), to deal in the Software
/// without restriction, including without limitation the rights to use, copy, modify, merge,
/// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
/// to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or
/// substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
/// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once
#ifndef win32event_h__
#define win32event_h__

#include "core/types.h"

namespace Win32
{
	////////////////////////////////////////////////////////////////////////////////////////////////////
	/// \class	Win32Event
	///
	/// \brief	Window 32 event. 
	/// 
	/// \todo	Add documentation!
	///
	/// \author	Markus
	/// \date	21.02.2010
	////////////////////////////////////////////////////////////////////////////////////////////////////
	class Win32Event
	{
	public:

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	Win32Event(bool manres = false)
		///
		/// \brief	Constructor. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param	manres	true to manres. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		Win32Event(bool manres = false);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	~Win32Event()
		///
		/// \brief	Finaliser. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		~Win32Event();




		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void Signal()
		///
		/// \brief	Signals this object. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void Signal();

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void Reset()
		///
		/// \brief	Resets this object. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void Reset();

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void Wait() const
		///
		/// \brief	Waits this object. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void Wait() const;

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	bool WaitTimeout(int ms) const
		///
		/// \brief	Wait timeout. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param	ms	The milliseconds. 
		///
		/// \return	true if it succeeds, false if it fails. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		bool WaitTimeout(int ms) const;

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	bool Peek() const
		///
		/// \brief	Returns the top-of-stack object without removing it. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \return	The current top-of-stack object. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		bool Peek() const;

	protected:

	private:

		HANDLE m_event;

	};

}

#endif // win32event_h__